package afcp.alumni.search;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Sets whether the annotated class and its annotated to be indexable and
 * searchable using the search API.
 * 
 * @author architruc
 * 
 */
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@Target({ ElementType.TYPE, ElementType.FIELD })
public @interface Indexable {
	public static enum Locale { FR, EN, ZH, NONE }
	
	/**
	 * Sets the locale of the marked field. If not on a text field, this
	 * parameter will be ignored. Use one of the {@link Locale} values
	 * 
	 * @return
	 */
	Locale locale() default Locale.NONE;
}
